Manage Appointment API
Best practices
This API meets the following Chorus business rules to ensure this API follows best practices.
| Chorus business rules | Endpoint | Description |
|---|---|---|
| Chorus-Appointment-1 | ALL | Calendar days For this API, "days" always means calendar days. |
| Chorus-Appointment-2 | ALL | Public holidays Appointments cannot be reserved or scheduled for a national NZ public holiday. |
| Chorus-BIC004-3 | /siteVisitAppointmentAvailability | Site visit appointment availability search requests Dates submitted as search criteria must meet the following conditions: 1. Requested appointment start date must be greater than the current date. 2. Requested appointment end date and time must be: - greater than the appointment start date and time - less than or equal to 89 days. |
| Chorus-Appointment-4 | /rfsAppointmentAvailability | RFS appointment availability search requests Dates submitted as search criteria must meet the following conditions: 1. Requested appointment start time must be greater than the current time (+1hr and rounded up to the next hour). 2. Requested appointment start time must not exceed 89 days. |
| Chorus-BIC004-5 | /siteVisitAppointmentAvailability /siteVisitAppointment | Calculating lead time When calculating lead time, the system will return available dates and times as a morning (AM) or an afternoon (PM) appointment. Where appointments are available, dates will begin on either the: - following business day, if the request is submitted during business hours OR - second business day, if the request is submitted out of business hours (on weekends, holidays or after 5pm during a business day). Learn more about Site visit appointment types and lead times |
| Chorus-BIC004-6 | /siteVisitAppointmentAvailability | Retrieve site visit appointments If you’re trying to retrieve appointments for an order that you intend to create, you must have completed a POST /orderFeasibility and received a response with the FEASIBILITY_CODE: 998. |
| Chorus-BIC005-8 | /siteVisitAppointment | Reservation expiry timeframe The appointment reservation: - triggers an expiration timer of 30 minutes - will expire if the appointment is not confirmed within this timeframe. Note: After the reservation expires, you will need to reserve a new appointment to continue. |
| Chorus-BIC004-9 | /siteVisitAppointment | Scheduling site visit appointments If you’re trying to schedule an appointment for an order that you intend to create and the siteVisitRequired attribute as part of order feasibility response is True, use PUT /siteVisitAppointment to reserve the appointment. |
| Chorus-Appointment-10 | / rfsAppointment | Scheduling RFS appointments If you’re trying to schedule an appointment for an order that you intend to create and the siteVisitRequired attribute as part of order feasibility response is False, use a Connect or Disconnect RFS Date Time in the POST /orders/{orderId}. |
| Chorus-BIC004-11 | /siteVisitAppointment | Rescheduling site visit appointments If you’re trying to reschedule an order with a site visit, use PUT /siteVisitAppointment to reserve a new appointment. The order must then be in a valid state for an appointment to be scheduled: Held/Schedule Install or Held/Schedule Scoping, In Progress/Scheduled or In Progress/Scoping Scheduled. |
| Chorus-BIC004-12 | /rfsAppointment | Rescheduling RFS appointments If you’re trying to reschedule an appointment for an order without a site visit, use PUT /rfsAppointment to reschedule the order. The order must then be in a valid state for an appointment to be scheduled: In Progress/Scheduled. |
| Chorus-Appointment-13 | /siteVisitAppointment | Advanced scheduling If advanced scheduling is available for your order, you will be informed in the Order Feasibility response by attribute advancedScheduling will have value: available. You can schedule a site visit while Chorus completes pre-work on the order. |
| Chorus-BIC005-14 | /siteVisitAppointmentAvailability /siteVisitAppointment | Inter-appointment lead times An Inter-Appointment Lead time is the time between two appointments on the same order. For example, an order may require both Scope and Install appointments. The Order Feasibility query will return a Site ID for each appointment type. You must book an appointment for each site visit type, using the appropriate Inter-appointment lead-times. The validateInterAppointmentLeadTime attribute provides the option of choosing appointment dates and times which comply with the Inter-appointment lead-time rules. Learn more about inter-appointment lead times Learn more about site visit appointment types and lead times |
| Chorus-BIC005-15 | /siteVisitAppointment | Update existing appointment costs Appointments rescheduled after 3pm on the business day before they are scheduled to start, may be subject to additional charges. |